Show:

ia.MapController Class

Defined in: ia\maps\MapController.js:1
Module: ia

Used to control chart navigation.

Constructor

ia.MapController

(
  • m
)

Defined in ia\maps\MapController.js:1

Parameters:

Methods

centerOnCoords

(
  • px
  • py
)

Defined in ia\maps\MapController.js:145

Centers the view on a pair of coordinates.

Parameters:

  • px Number

    The x-coord (data units).

  • py Number

    The y-coord (data units).

centerOnCursor

()

Defined in ia\maps\MapController.js:124

Centers the view on the cursor position.

centerOnPoint

(
  • p
)

Defined in ia\maps\MapController.js:134

Centers the view on a point.

Parameters:

changeBBox

(
  • dXMin
  • dYMin
  • dXMax
  • dYMax
)

Defined in ia\maps\MapController.js:332

Changes the bounding box using the given distances.

Parameters:

  • dXMin Number

    The change in the xMin (data units).

  • dYMin Number

    The change in the yMin (data units).

  • dXMax Number

    The change in the xMax (data units).

  • dYMax Number

    The change in the yMax (data units).

pan

(
  • direction
  • ratio
)

Defined in ia\maps\MapController.js:79

Pans the given direction and distance.

Parameters:

  • direction Number

    The direction in degrees. Valid values are >=0 and <=360.

  • ratio Number

    To calculate the distance moved, ratio is multiplied by the bBox width or height (depending on the direction of the pan).

    The bBox is then shifted by the calculated distance.

    Valid values are > 0.

panDistance

(
  • direction
  • distance
)

Defined in ia\maps\MapController.js:106

Pans the given direction and distance.

Parameters:

  • direction Number

    The direction in degrees. Valid values are >=0 and <=360.

  • distance Number

    The distance (data units).

panE

()

Defined in ia\maps\MapController.js:37

Pans East.

panN

()

Defined in ia\maps\MapController.js:23

Pans North.

panNE

()

Defined in ia\maps\MapController.js:30

Pans North-East.

panNW

()

Defined in ia\maps\MapController.js:72

Pans North-West.

panS

()

Defined in ia\maps\MapController.js:51

Pans South.

panSE

()

Defined in ia\maps\MapController.js:44

Pans South-East.

panSW

()

Defined in ia\maps\MapController.js:58

Pans South-West.

panW

()

Defined in ia\maps\MapController.js:65

Pans West.

resetBBox

(
  • bx
  • by
  • bw
  • bh
)

Defined in ia\maps\MapController.js:384

Zooms to a bounding box as defined by the following parameters. This is a utility function so that bounding boxes can be dealt with in terms of their x, y, width and height;

Parameters:

  • bx Number

    The x position of the bBox.

  • by Number

    The y position of the bBox.

  • bw Number

    The width of the bBox.

  • bh Number

    The height of the bBox.

translate

(
  • dx
  • dy
)

Defined in ia\maps\MapController.js:161

Moves the view by the given distance.

Parameters:

  • dx Number

    The distance in the x direction (data units).

  • dy Number

    The distance in the y direction (data units).

zoomFull

()

Defined in ia\maps\MapController.js:363

Zooms to full extents as defined by the default bBox.

zoomIn

()

Defined in ia\maps\MapController.js:177

Zooms in around the center of the view.

zoomInOnCursor

()

Defined in ia\maps\MapController.js:217

Zooms in around the cursor position.

zoomOnCenter

(
  • ratio
)

Defined in ia\maps\MapController.js:197

Zooms around the center of the view.

Parameters:

  • ratio Number

    To calculate the distance zoomed, the bBox width and height are multiplied by the ratio.

    Valid values are > 0.

    Values > 1 will cause the view to zoom out. values < 1 will cause the view to zoom in.

zoomOnCoords

(
  • px
  • py
  • ratio
)

Defined in ia\maps\MapController.js:274

Zooms in around a pair of coordinates.

Parameters:

  • px Number

    The x-coord (data units).

  • py Number

    The y-coord (data units).

  • ratio Number

    To calculate the distance zoomed, the bBox width and height are multiplied by the ratio.

    Valid values are > 0.

    Values > 1 will cause the view to zoom out. values < 1 will cause the view to zoom in.

zoomOnCursor

(
  • ratio
)

Defined in ia\maps\MapController.js:237

Zooms around the cursor position by the given ratio.

Parameters:

  • ratio Number

    To calculate the distance zoomed, the bBox width and height are multiplied by the ratio.

    Valid values are > 0.

    Values > 1 will cause the view to zoom out. values < 1 will cause the view to zoom in.

zoomOnPoint

(
  • px
  • ratio
)

Defined in ia\maps\MapController.js:255

Zooms in around a point.

Parameters:

  • px ia.Point

    The point (data units).

  • ratio Number

    To calculate the distance zoomed, the bBox width and height are multiplied by the ratio.

    Valid values are > 0.

    Values > 1 will cause the view to zoom out. values < 1 will cause the view to zoom in.

zoomOut

()

Defined in ia\maps\MapController.js:187

Zooms out around the center of the view.

zoomOutOnCursor

()

Defined in ia\maps\MapController.js:227

Zooms out around the cursor position.

zoomToBBox

(
  • bb
)

Defined in ia\maps\MapController.js:373

Zooms to a bounding box.

Parameters:

zoomToExtent

(
  • extent
)

Defined in ia\maps\MapController.js:315

Zooms to an extent around the center of the view.

Parameters:

  • extent Object

    The extent to zoom to (data units).

zoomToPointExtent

(
  • p1
  • p2
)

Defined in ia\maps\MapController.js:299

Zooms to an extent as defined by two points.

Parameters:

zoomToRect

(
  • rect
)

Defined in ia\maps\MapController.js:352

Zooms to a rectangle if the rectangle is greater than 5*5 pixels.

Parameters:

Properties

defaultBBox

ia.BoundingBox

Defined in ia\maps\MapController.js:15

A default BoundingBox for the view.